Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

LBSGD documentation fix #13465

Merged
merged 1 commit into from
Dec 5, 2018
Merged

LBSGD documentation fix #13465

merged 1 commit into from
Dec 5, 2018

Conversation

anirudhacharya
Copy link
Member

@anirudhacharya anirudhacharya commented Nov 29, 2018 •
edited
Loading

Description

LBSGD documentation fix

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • added correct information for the optimizer update rules

@vandanavk
Copy link
Contributor

@mxnet-label-bot add [Doc,pr-awaiting-review]

@aaronmarkham

@marcoabreu marcoabreu added Doc pr-awaiting-review PR is waiting for code review labels Nov 29, 2018
@anirudhacharya
Copy link
Member Author

@eric-haibin-lin does this fix this #12171
the same issue exists in the new beta website and I think this PR will fix that.

@eric-haibin-lin
Copy link
Member

Thanks for the fix

@vandanavk
Copy link
Contributor

@mxnet-label-bot remove [pr-awaiting-review]

@marcoabreu marcoabreu removed the pr-awaiting-review PR is waiting for code review label Dec 3, 2018
@vandanavk
Copy link
Contributor

@mxnet-label-bot add [pr-awaiting-merge]

@marcoabreu marcoabreu added the pr-awaiting-merge Review and CI is complete. Ready to Merge label Dec 3, 2018
@ChaiBapchya
Copy link
Contributor

Job failed, looks like another CI issue?

@aaronmarkham
Copy link
Contributor

Restarted it for you... it might pass this time.

aaronmarkham
aaronmarkham approved these changes Dec 5, 2018
View reviewed changes
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Preview here looks good: http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13465/2/api/python/optimization/optimization.html#mxnet.optimizer.LBSGD

@aaronmarkham aaronmarkham merged commit 0f85f5d into apache:master Dec 5, 2018
zhaoyao73 pushed a commit to zhaoyao73/incubator-mxnet that referenced this pull request Dec 13, 2018
@anirudhacharya @zhaoyao73
doc fix (apache#13465)
b1a8417
@anirudhacharya anirudhacharya deleted the lbsgdDoc branch January 12, 2019 10:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ChaiBapchya ChaiBapchya ChaiBapchya approved these changes

@vandanavk vandanavk vandanavk approved these changes

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@eric-haibin-lin eric-haibin-lin eric-haibin-lin approved these changes

@szha szha Awaiting requested review from szha

Assignees
No one assigned
Labels
Doc pr-awaiting-merge Review and CI is complete. Ready to Merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@anirudhacharya @vandanavk @eric-haibin-lin @ChaiBapchya @aaronmarkham @marcoabreu